home *** CD-ROM | disk | FTP | other *** search
/ Amiga Inside! / Amiga FD Inside (1995)(Ultramax).iso / forumamiga / programme / tinyclock / tinyclock.doc < prev    next >
Encoding:
Text File  |  1992-05-30  |  5.0 KB  |  150 lines
  1.  
  2. TinyClock v1.0
  3. --------------
  4. NB: TinyClock only works with AmigaDos 2.0 or higher (sorry).
  5. [Released in April '92.]
  6.  
  7.  
  8. There are far too many clock programs for the Amiga -- it seems that
  9. no-one likes what's on offer and so writes their own, and places it in
  10. the Public Domain. And good, too: we have a LOT of choice.
  11.  
  12. But what about analog clocks? Well, there's Commodore's clock, but that
  13. uses over 40K memory and too much of the processor. Then there's
  14. WizardClock, but again that is big, and not resizeable (though it is
  15. neat, and has lots of nice extras).
  16.  
  17. But, like so many before me, the clock I wanted wasn't there. One that
  18. came close was a small analog clock by Matt Dillon. It was rather too
  19. limited though. However, using that source as a starting point, I
  20. produced TinyClock. Much has been added, for both aesthetics and
  21. functionality. Here's a rundown of TinyClock's features:
  22.  
  23.     -    Resizeable analog display;
  24.  
  25.     -    Colors used in clock rendering can be changed as desired;
  26.  
  27.     -    Can save position and colors for subsequent sessions;
  28.  
  29.     -    Optionally chirps every quarter-hour, and twice on the hour;
  30.  
  31.     -    Whole window is a 'drag bar', except right-hand and bottom
  32.     edges, which act as a 'sizing gadget';
  33.  
  34.     -    Displays day and date in MenuBar when window is active;
  35.  
  36.     -    WB 2.0 'icon look', with menus that use screen's font;
  37.  
  38.     -    Small binary (<6K), uses less than 13K memory running;
  39.  
  40.     -    Uses miniscule amount of processor (only updates once/minute).
  41.  
  42. Usage Notes
  43. -----------
  44. To start, double click on the TinyClock icon. The first time you run,
  45. the clock will use default sizes and colors - configure it the way you
  46. want, and select 'Save prefs' from the TinyClock menu. TinyClock will
  47. then always use these settings. (The preferences are saved to a file
  48. called 'S:TinyClock.config'.)
  49.  
  50. You may of course start TinyClock from the CLI, but it does not
  51. self-detatch, and would have to be 'run' if you wanted to continue using
  52. the CLI.
  53.  
  54. Best way to start it, though, is to shove it in your WBStartup drawer;
  55. if you do, set the DONOTWAIT tooltype for Workbench.
  56.  
  57. To keep binary size down, TinyClock takes no command-line options or
  58. tooltypes - it uses a config-file instead, as mentioned above. A stack
  59. of 2500 bytes seems sufficient for TinyClock (I've had no problems).
  60.  
  61. Strange behaviour
  62. ----------------
  63. Since TinyClock updates only once per minute (but in such a way that the
  64. minute-hand moves exactly when the minute is up), if you change the system
  65. date, it will take upto a minute to be reflected on the clock display.
  66. You can however click into the window, and it will be updated immediately.
  67.  
  68. The imagery used to draw the clock (hands, pips) is NOT scaled (unlike
  69. the Commodore clock). TinyClock is intended to be just that, and looks
  70. pretty ugly if made large. But then, who wants a clock taking up half
  71. the screen?
  72.  
  73. No other unexpected behaviour is known.
  74.  
  75. The Menus
  76. ---------
  77. Self-explanatory, I hope. Here's a quick rundown though...
  78.  
  79. TinyClock menu:
  80.  
  81.  To Front    Sends clock window to front (there are no depth gadgets)
  82.  To Back    Sends clock window to back
  83.  Chirp        If checked, will beep on quarter-hour (& twice on the hour)
  84.  Reset prefs    Reloads previously saved configuration
  85.  Save prefs    Save current position/size/colors to configuration file
  86.  About        Displays a small message
  87.  Quit        You don't want to do that...
  88.  
  89. Colors menu:    (0-3 denote system colors)
  90.  
  91.  Background    The color of the clock window
  92.  Hour hand    The color of the hour hand
  93.  Hour hand    The color of the minute hand
  94.  Pips        The color of the pips (hour marks)
  95.  
  96. If using Workbench default (2.0) colors,
  97.     0 is lightish-grey,
  98.     1 is black,
  99.     2 is white,
  100.     3 is mid-blue.
  101.  
  102. Of course, some combinations look better than others, and some are
  103. downright useless (like black hands on a black background...).
  104.  
  105. That's the menus. As mentioned in the 'features' list, almost the whole
  106. window is a 'drag bar' (this is like some programs' iconified states).
  107. The picture below shows what parts of the window do what:
  108.  
  109.     +-------------------------+-+
  110.     |              | |
  111.     |              | |
  112.     |    Click here to      | <----    Click in this region
  113.     |              | |
  114.     |      position      | |          to resize window
  115.     |              | |
  116.     |       window      | |
  117.     |              | |
  118.     |              | |
  119.     |-------------------------+ |
  120.     +---------------------------+
  121.  
  122. Author and Credits
  123. ------------------
  124. Original clock code was (C) Matt Dillon (although it's now unrecognisable).
  125. TinyClock is written in C and compiled with SAS (Lattice) C v5.10a.
  126. Thanks to Mike Meyer et al. for Mg3 (the best pd text editor) and Steve
  127. Koren for SKsh.
  128.  
  129. I am always happy to receive bug-reports, comments or suggestions for
  130. enhancement of programs I write. I can be contacted by postal mail at:
  131.  
  132.     Martin W. Scott,
  133.     23 Drum Brae North,
  134.     Edinburgh,
  135.     EH4 8AT
  136.     United Kingdom.
  137.  
  138. or by email: mws@castle.ed.ac.uk
  139.  
  140. TinyClock is freely redistributable, as long as this documentation
  141. (unaltered) accompanies it. It may not be sold for profit or included in
  142. any commercial product (and that includes magazines) without permission.
  143. Contributions are not obligatory, but are always welcome (I'm yet
  144. another poor student). 
  145.  
  146.  
  147. Enjoy!
  148.  
  149.  Martin.
  150.